home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / text / misc / manfilt_v1_1.lha / manfilt / manfilt.doc < prev    next >
Text File  |  1995-09-02  |  3KB  |  127 lines
  1.  
  2.  
  3.  
  4.  manfilt(1)                     ROM 2.04 only                     manfilt(1)
  5.  
  6.  
  7.  
  8.  
  9.  NAME
  10.       manfilt - Strip or convert nroff tty sequences to ANSI/AmigaGuide
  11.       sequences
  12.  
  13.  SYNOPSIS
  14.       manfilt [ BOLD style ] [ UNDERLINE style ] [ STRIP | GUIDE ]
  15.  
  16.  DESCRIPTION
  17.       manfilt is a program which reads output by nroff, troff or groff for
  18.       tty devices and converts the familiar `c BACKSPACE c' to either ANSI
  19.       sequences or AmigaGuide sequences.
  20.  
  21.       manfilt reads from standard input and outputs the converted text to
  22.       standard output.
  23.  
  24.     Options
  25.       The options supported by manfilt are:
  26.  
  27.       BOLD -      Specifies the style used for the nroff bold sequences ( `c
  28.                   BACKSPACE c' ).
  29.  
  30.       UNDERLINE - Specifies the style used for the nroff underline sequences
  31.                   ( `_ BACKSPACE c' ).
  32.  
  33.       STRIP -     Simply strip out all nroff sequences, and add no new ones.
  34.  
  35.       GUIDE -     Use AmigaGuide control sequences instead of ANSI
  36.                   sequences.
  37.  
  38.       manfilt currently supports these styles:
  39.  
  40.            0 - Plain.
  41.  
  42.            1 - Bold.
  43.  
  44.            2 - Italic.
  45.  
  46.            3 - Underline.
  47.  
  48.            4 - Inverse video.
  49.  
  50.  EXAMPLES
  51.       These are the commands used to create the AmigaGuide and the ANSI
  52.       versions of the manfilt document:
  53.  
  54.       manfilt <manfilt.txt >manfilt.guide GUIDE
  55.  
  56.       manfilt <manfilt.txt >manfilt.doc
  57.  
  58.       To change the default style of the underline font to italic, use:
  59.  
  60.  
  61.  
  62.  
  63.                                     - 1 -        Release 1.1: September 1995
  64.  
  65.  
  66.  
  67.  manfilt(1)                     ROM 2.04 only                     manfilt(1)
  68.  
  69.  
  70.  
  71.  
  72.       manfilt <manfilt.txt >manfilt.guide UNDERLINE=2
  73.  
  74.  
  75.  BUGS
  76.       Notice that manfilt is not very intelligent about what it is doing.
  77.       This is most notable for the AmigaGuide format.  The sequences
  78.       generated in this format to reset the style to plain, must reset bold,
  79.       italic, underline, and inverse video. This slows down the display of
  80.       the resulting AmigaGuide file. Under V40 of the AmigaGuide format
  81.       there is a special command for resetting the first three styles at
  82.       once. If you wish to use this (and loose compatibility with pre V40
  83.       guides) replace the sequence `@{UB}@{UU}@{UI}' with `@{PLAIN}'. Also,
  84.       if your converted text does not contain the inverse video style,
  85.       delete all occurrences of the `@{BG Background}@{FG Text}' sequence.
  86.  
  87.  AUTHOR
  88.       Nils Peter Sudmann (nilss@stud.cs.uit.no)
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                     - 2 -        Release 1.1: September 1995
  127.